/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.runtime.dispatcher.cleanup;

import org.apache.flink.api.common.JobID;
import org.apache.flink.runtime.concurrent.ComponentMainThreadExecutor;

import java.util.concurrent.Executor;

/**
 * {@code ResourceCleanerFactory} provides methods to create {@link ResourceCleaner} for local and
 * global cleanup.
 *
 * @see GloballyCleanableResource
 * @see LocallyCleanableResource
 */
public interface ResourceCleanerFactory {

    /**
     * Creates {@link ResourceCleaner} that initiates {@link
     * LocallyCleanableResource#localCleanupAsync(JobID, Executor)} calls.
     *
     * @param mainThreadExecutor Used for validating that the {@link
     *     LocallyCleanableResource#localCleanupAsync(JobID, Executor)} is called from the main
     *     thread.
     */
    ResourceCleaner createLocalResourceCleaner(ComponentMainThreadExecutor mainThreadExecutor);

    /**
     * Creates {@link ResourceCleaner} that initiates {@link
     * GloballyCleanableResource#globalCleanupAsync(JobID, Executor)} calls.
     *
     * @param mainThreadExecutor Used for validating that the {@link
     *     GloballyCleanableResource#globalCleanupAsync(JobID, Executor)} is called from the main
     *     thread.
     */
    ResourceCleaner createGlobalResourceCleaner(ComponentMainThreadExecutor mainThreadExecutor);
}
